home *** CD-ROM | disk | FTP | other *** search
- /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
- /* ***** BEGIN LICENSE BLOCK *****
- * Version: MPL 1.1/GPL 2.0/LGPL 2.1
- *
- * The contents of this file are subject to the Mozilla Public License Version
- * 1.1 (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- * http://www.mozilla.org/MPL/
- *
- * Software distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
- * for the specific language governing rights and limitations under the
- * License.
- *
- * The Original Code is mozilla.org code.
- *
- * The Initial Developer of the Original Code is
- * Netscape Communications Corporation.
- * Portions created by the Initial Developer are Copyright (C) 1999
- * the Initial Developer. All Rights Reserved.
- *
- * Contributor(s):
- * Radha Kulkarni (radha@netscape.com)
- *
- * Alternatively, the contents of this file may be used under the terms of
- * either of the GNU General Public License Version 2 or later (the "GPL"),
- * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
- * in which case the provisions of the GPL or the LGPL are applicable instead
- * of those above. If you wish to allow use of your version of this file only
- * under the terms of either the GPL or the LGPL, and not to allow others to
- * use your version of this file under the terms of the MPL, indicate your
- * decision by deleting the provisions above and replace them with the notice
- * and other provisions required by the GPL or the LGPL. If you do not delete
- * the provisions above, a recipient may use your version of this file under
- * the terms of any one of the MPL, the GPL or the LGPL.
- *
- * ***** END LICENSE BLOCK ***** */
-
- #include "nsISupports.idl"
- #include "nsIFactory.idl"
- #include "nsISHEntry.idl"
- #include "nsISHTransaction.idl"
-
- interface nsISHistoryListener;
- interface nsIDocShell;
-
- %{C++
- #define NS_SHISTORY_INTERNAL_CID \
- {0x5b4cba4c, 0xbf67, 0x499a, {0xae, 0x2c, 0x3f, 0x76, 0x65, 0x6f, 0x4a, 0x4e}}
-
- #define NS_SHISTORY_INTERNAL_CONTRACTID "@mozilla.org/browser/shistory-internal;1"
- %}
-
- [scriptable, uuid(494fac3c-64f4-41b8-b209-b4ada899613b)]
- interface nsISHistoryInternal: nsISupports
- {
- /**
- * Add a new Entry to the History List
- * @param aEntry - The entry to add
- * @param aPersist - If true this specifies that the entry should persist
- * in the list. If false, this means that when new entries are added
- * this element will not appear in the session history list.
- */
- void addEntry(in nsISHEntry aEntry, in boolean aPersist);
-
- /**
- * Get the root transaction
- */
- readonly attribute nsISHTransaction rootTransaction;
-
- /**
- * The toplevel docshell object to which this SHistory object belongs to.
- */
- attribute nsIDocShell rootDocShell;
-
- /**
- * Update the index maintained by sessionHistory
- */
- void updateIndex();
-
- /**
- * Replace the nsISHEntry at a particular index
- * @param aIndex - The index at which the entry shoud be replaced
- * @param aReplaceEntry - The replacement entry for the index.
- */
- void replaceEntry(in long aIndex, in nsISHEntry aReplaceEntry);
-
- /**
- * Get handle to the history listener
- */
- readonly attribute nsISHistoryListener listener;
-
- /**
- * Evict content viewers until the number of content viewers per tab
- * is no more than gHistoryMaxViewers. Also, count
- * total number of content viewers globally and evict one if we are over
- * our total max. This is always called in Show(), after we destroy
- * the previous viewer.
- */
- void evictContentViewers(in long previousIndex, in long index);
-
- /**
- * Max number of total cached content viewers. If the pref
- * browser.sessionhistory.max_total_viewers is negative, then
- * this value is calculated based on the total amount of memory.
- * Otherwise, it comes straight from the pref.
- */
- readonly attribute long historyMaxTotalViewers;
- };
-